home *** CD-ROM | disk | FTP | other *** search
- /*
- * DO NOT EDIT. THIS FILE IS GENERATED FROM nsIHttpProtocolHandler.idl
- */
-
- #ifndef __gen_nsIHttpProtocolHandler_h__
- #define __gen_nsIHttpProtocolHandler_h__
-
-
- #ifndef __gen_nsIProxiedProtocolHandler_h__
- #include "nsIProxiedProtocolHandler.h"
- #endif
-
- /* For IDL files that don't want to include root IDL files. */
- #ifndef NS_NO_VTABLE
- #define NS_NO_VTABLE
- #endif
-
- /* starting interface: nsIHttpProtocolHandler */
- #define NS_IHTTPPROTOCOLHANDLER_IID_STR "122c91c0-2485-40ba-89c9-b895934921bc"
-
- #define NS_IHTTPPROTOCOLHANDLER_IID \
- {0x122c91c0, 0x2485, 0x40ba, \
- { 0x89, 0xc9, 0xb8, 0x95, 0x93, 0x49, 0x21, 0xbc }}
-
- class NS_NO_VTABLE nsIHttpProtocolHandler : public nsIProxiedProtocolHandler {
- public:
-
- NS_DEFINE_STATIC_IID_ACCESSOR(NS_IHTTPPROTOCOLHANDLER_IID)
-
- /**
- * Get the HTTP advertised user agent string.
- */
- /* readonly attribute ACString userAgent; */
- NS_IMETHOD GetUserAgent(nsACString & aUserAgent) = 0;
-
- /**
- * Get the application name.
- *
- * @return The name of this application (eg. "Mozilla").
- */
- /* readonly attribute ACString appName; */
- NS_IMETHOD GetAppName(nsACString & aAppName) = 0;
-
- /**
- * Get the application version string.
- *
- * @return The complete version (major and minor) string. (eg. "5.0")
- */
- /* readonly attribute ACString appVersion; */
- NS_IMETHOD GetAppVersion(nsACString & aAppVersion) = 0;
-
- /**
- * @return The vendor name.
- */
- /* attribute ACString vendor; */
- NS_IMETHOD GetVendor(nsACString & aVendor) = 0;
- NS_IMETHOD SetVendor(const nsACString & aVendor) = 0;
-
- /**
- * @return The vendor sub string.
- */
- /* attribute ACString vendorSub; */
- NS_IMETHOD GetVendorSub(nsACString & aVendorSub) = 0;
- NS_IMETHOD SetVendorSub(const nsACString & aVendorSub) = 0;
-
- /**
- * @return The vendor comment.
- */
- /* attribute ACString vendorComment; */
- NS_IMETHOD GetVendorComment(nsACString & aVendorComment) = 0;
- NS_IMETHOD SetVendorComment(const nsACString & aVendorComment) = 0;
-
- /**
- * @return The product name.
- */
- /* attribute ACString product; */
- NS_IMETHOD GetProduct(nsACString & aProduct) = 0;
- NS_IMETHOD SetProduct(const nsACString & aProduct) = 0;
-
- /**
- * @return A product sub string.
- */
- /* attribute ACString productSub; */
- NS_IMETHOD GetProductSub(nsACString & aProductSub) = 0;
- NS_IMETHOD SetProductSub(const nsACString & aProductSub) = 0;
-
- /**
- * @return A product comment.
- */
- /* attribute ACString productComment; */
- NS_IMETHOD GetProductComment(nsACString & aProductComment) = 0;
- NS_IMETHOD SetProductComment(const nsACString & aProductComment) = 0;
-
- /**
- * Get the current platform.
- *
- * @return The platform this application is running on
- * (eg. "Windows", "Macintosh", "X11")
- */
- /* readonly attribute ACString platform; */
- NS_IMETHOD GetPlatform(nsACString & aPlatform) = 0;
-
- /**
- * Get the current oscpu.
- *
- * @return The oscpu this application is running on
- */
- /* readonly attribute ACString oscpu; */
- NS_IMETHOD GetOscpu(nsACString & aOscpu) = 0;
-
- /**
- * Get the translation of the application. The value for language
- * is usually a 2-letter code such as "en" and occasionally a
- * five-character code to indicate a language subtype, such as "zh_CN".
- */
- /* attribute ACString language; */
- NS_IMETHOD GetLanguage(nsACString & aLanguage) = 0;
- NS_IMETHOD SetLanguage(const nsACString & aLanguage) = 0;
-
- /**
- * Get/Set the application comment misc portion.
- */
- /* attribute ACString misc; */
- NS_IMETHOD GetMisc(nsACString & aMisc) = 0;
- NS_IMETHOD SetMisc(const nsACString & aMisc) = 0;
-
- };
-
- /* Use this macro when declaring classes that implement this interface. */
- #define NS_DECL_NSIHTTPPROTOCOLHANDLER \
- NS_IMETHOD GetUserAgent(nsACString & aUserAgent); \
- NS_IMETHOD GetAppName(nsACString & aAppName); \
- NS_IMETHOD GetAppVersion(nsACString & aAppVersion); \
- NS_IMETHOD GetVendor(nsACString & aVendor); \
- NS_IMETHOD SetVendor(const nsACString & aVendor); \
- NS_IMETHOD GetVendorSub(nsACString & aVendorSub); \
- NS_IMETHOD SetVendorSub(const nsACString & aVendorSub); \
- NS_IMETHOD GetVendorComment(nsACString & aVendorComment); \
- NS_IMETHOD SetVendorComment(const nsACString & aVendorComment); \
- NS_IMETHOD GetProduct(nsACString & aProduct); \
- NS_IMETHOD SetProduct(const nsACString & aProduct); \
- NS_IMETHOD GetProductSub(nsACString & aProductSub); \
- NS_IMETHOD SetProductSub(const nsACString & aProductSub); \
- NS_IMETHOD GetProductComment(nsACString & aProductComment); \
- NS_IMETHOD SetProductComment(const nsACString & aProductComment); \
- NS_IMETHOD GetPlatform(nsACString & aPlatform); \
- NS_IMETHOD GetOscpu(nsACString & aOscpu); \
- NS_IMETHOD GetLanguage(nsACString & aLanguage); \
- NS_IMETHOD SetLanguage(const nsACString & aLanguage); \
- NS_IMETHOD GetMisc(nsACString & aMisc); \
- NS_IMETHOD SetMisc(const nsACString & aMisc);
-
- /* Use this macro to declare functions that forward the behavior of this interface to another object. */
- #define NS_FORWARD_NSIHTTPPROTOCOLHANDLER(_to) \
- NS_IMETHOD GetUserAgent(nsACString & aUserAgent) { return _to GetUserAgent(aUserAgent); } \
- NS_IMETHOD GetAppName(nsACString & aAppName) { return _to GetAppName(aAppName); } \
- NS_IMETHOD GetAppVersion(nsACString & aAppVersion) { return _to GetAppVersion(aAppVersion); } \
- NS_IMETHOD GetVendor(nsACString & aVendor) { return _to GetVendor(aVendor); } \
- NS_IMETHOD SetVendor(const nsACString & aVendor) { return _to SetVendor(aVendor); } \
- NS_IMETHOD GetVendorSub(nsACString & aVendorSub) { return _to GetVendorSub(aVendorSub); } \
- NS_IMETHOD SetVendorSub(const nsACString & aVendorSub) { return _to SetVendorSub(aVendorSub); } \
- NS_IMETHOD GetVendorComment(nsACString & aVendorComment) { return _to GetVendorComment(aVendorComment); } \
- NS_IMETHOD SetVendorComment(const nsACString & aVendorComment) { return _to SetVendorComment(aVendorComment); } \
- NS_IMETHOD GetProduct(nsACString & aProduct) { return _to GetProduct(aProduct); } \
- NS_IMETHOD SetProduct(const nsACString & aProduct) { return _to SetProduct(aProduct); } \
- NS_IMETHOD GetProductSub(nsACString & aProductSub) { return _to GetProductSub(aProductSub); } \
- NS_IMETHOD SetProductSub(const nsACString & aProductSub) { return _to SetProductSub(aProductSub); } \
- NS_IMETHOD GetProductComment(nsACString & aProductComment) { return _to GetProductComment(aProductComment); } \
- NS_IMETHOD SetProductComment(const nsACString & aProductComment) { return _to SetProductComment(aProductComment); } \
- NS_IMETHOD GetPlatform(nsACString & aPlatform) { return _to GetPlatform(aPlatform); } \
- NS_IMETHOD GetOscpu(nsACString & aOscpu) { return _to GetOscpu(aOscpu); } \
- NS_IMETHOD GetLanguage(nsACString & aLanguage) { return _to GetLanguage(aLanguage); } \
- NS_IMETHOD SetLanguage(const nsACString & aLanguage) { return _to SetLanguage(aLanguage); } \
- NS_IMETHOD GetMisc(nsACString & aMisc) { return _to GetMisc(aMisc); } \
- NS_IMETHOD SetMisc(const nsACString & aMisc) { return _to SetMisc(aMisc); }
-
- /* Use this macro to declare functions that forward the behavior of this interface to another object in a safe way. */
- #define NS_FORWARD_SAFE_NSIHTTPPROTOCOLHANDLER(_to) \
- NS_IMETHOD GetUserAgent(nsACString & aUserAgent) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetUserAgent(aUserAgent); } \
- NS_IMETHOD GetAppName(nsACString & aAppName) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetAppName(aAppName); } \
- NS_IMETHOD GetAppVersion(nsACString & aAppVersion) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetAppVersion(aAppVersion); } \
- NS_IMETHOD GetVendor(nsACString & aVendor) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetVendor(aVendor); } \
- NS_IMETHOD SetVendor(const nsACString & aVendor) { return !_to ? NS_ERROR_NULL_POINTER : _to->SetVendor(aVendor); } \
- NS_IMETHOD GetVendorSub(nsACString & aVendorSub) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetVendorSub(aVendorSub); } \
- NS_IMETHOD SetVendorSub(const nsACString & aVendorSub) { return !_to ? NS_ERROR_NULL_POINTER : _to->SetVendorSub(aVendorSub); } \
- NS_IMETHOD GetVendorComment(nsACString & aVendorComment) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetVendorComment(aVendorComment); } \
- NS_IMETHOD SetVendorComment(const nsACString & aVendorComment) { return !_to ? NS_ERROR_NULL_POINTER : _to->SetVendorComment(aVendorComment); } \
- NS_IMETHOD GetProduct(nsACString & aProduct) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetProduct(aProduct); } \
- NS_IMETHOD SetProduct(const nsACString & aProduct) { return !_to ? NS_ERROR_NULL_POINTER : _to->SetProduct(aProduct); } \
- NS_IMETHOD GetProductSub(nsACString & aProductSub) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetProductSub(aProductSub); } \
- NS_IMETHOD SetProductSub(const nsACString & aProductSub) { return !_to ? NS_ERROR_NULL_POINTER : _to->SetProductSub(aProductSub); } \
- NS_IMETHOD GetProductComment(nsACString & aProductComment) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetProductComment(aProductComment); } \
- NS_IMETHOD SetProductComment(const nsACString & aProductComment) { return !_to ? NS_ERROR_NULL_POINTER : _to->SetProductComment(aProductComment); } \
- NS_IMETHOD GetPlatform(nsACString & aPlatform) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetPlatform(aPlatform); } \
- NS_IMETHOD GetOscpu(nsACString & aOscpu) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetOscpu(aOscpu); } \
- NS_IMETHOD GetLanguage(nsACString & aLanguage) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetLanguage(aLanguage); } \
- NS_IMETHOD SetLanguage(const nsACString & aLanguage) { return !_to ? NS_ERROR_NULL_POINTER : _to->SetLanguage(aLanguage); } \
- NS_IMETHOD GetMisc(nsACString & aMisc) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetMisc(aMisc); } \
- NS_IMETHOD SetMisc(const nsACString & aMisc) { return !_to ? NS_ERROR_NULL_POINTER : _to->SetMisc(aMisc); }
-
- #if 0
- /* Use the code below as a template for the implementation class for this interface. */
-
- /* Header file */
- class nsHttpProtocolHandler : public nsIHttpProtocolHandler
- {
- public:
- NS_DECL_ISUPPORTS
- NS_DECL_NSIHTTPPROTOCOLHANDLER
-
- nsHttpProtocolHandler();
-
- private:
- ~nsHttpProtocolHandler();
-
- protected:
- /* additional members */
- };
-
- /* Implementation file */
- NS_IMPL_ISUPPORTS1(nsHttpProtocolHandler, nsIHttpProtocolHandler)
-
- nsHttpProtocolHandler::nsHttpProtocolHandler()
- {
- /* member initializers and constructor code */
- }
-
- nsHttpProtocolHandler::~nsHttpProtocolHandler()
- {
- /* destructor code */
- }
-
- /* readonly attribute ACString userAgent; */
- NS_IMETHODIMP nsHttpProtocolHandler::GetUserAgent(nsACString & aUserAgent)
- {
- return NS_ERROR_NOT_IMPLEMENTED;
- }
-
- /* readonly attribute ACString appName; */
- NS_IMETHODIMP nsHttpProtocolHandler::GetAppName(nsACString & aAppName)
- {
- return NS_ERROR_NOT_IMPLEMENTED;
- }
-
- /* readonly attribute ACString appVersion; */
- NS_IMETHODIMP nsHttpProtocolHandler::GetAppVersion(nsACString & aAppVersion)
- {
- return NS_ERROR_NOT_IMPLEMENTED;
- }
-
- /* attribute ACString vendor; */
- NS_IMETHODIMP nsHttpProtocolHandler::GetVendor(nsACString & aVendor)
- {
- return NS_ERROR_NOT_IMPLEMENTED;
- }
- NS_IMETHODIMP nsHttpProtocolHandler::SetVendor(const nsACString & aVendor)
- {
- return NS_ERROR_NOT_IMPLEMENTED;
- }
-
- /* attribute ACString vendorSub; */
- NS_IMETHODIMP nsHttpProtocolHandler::GetVendorSub(nsACString & aVendorSub)
- {
- return NS_ERROR_NOT_IMPLEMENTED;
- }
- NS_IMETHODIMP nsHttpProtocolHandler::SetVendorSub(const nsACString & aVendorSub)
- {
- return NS_ERROR_NOT_IMPLEMENTED;
- }
-
- /* attribute ACString vendorComment; */
- NS_IMETHODIMP nsHttpProtocolHandler::GetVendorComment(nsACString & aVendorComment)
- {
- return NS_ERROR_NOT_IMPLEMENTED;
- }
- NS_IMETHODIMP nsHttpProtocolHandler::SetVendorComment(const nsACString & aVendorComment)
- {
- return NS_ERROR_NOT_IMPLEMENTED;
- }
-
- /* attribute ACString product; */
- NS_IMETHODIMP nsHttpProtocolHandler::GetProduct(nsACString & aProduct)
- {
- return NS_ERROR_NOT_IMPLEMENTED;
- }
- NS_IMETHODIMP nsHttpProtocolHandler::SetProduct(const nsACString & aProduct)
- {
- return NS_ERROR_NOT_IMPLEMENTED;
- }
-
- /* attribute ACString productSub; */
- NS_IMETHODIMP nsHttpProtocolHandler::GetProductSub(nsACString & aProductSub)
- {
- return NS_ERROR_NOT_IMPLEMENTED;
- }
- NS_IMETHODIMP nsHttpProtocolHandler::SetProductSub(const nsACString & aProductSub)
- {
- return NS_ERROR_NOT_IMPLEMENTED;
- }
-
- /* attribute ACString productComment; */
- NS_IMETHODIMP nsHttpProtocolHandler::GetProductComment(nsACString & aProductComment)
- {
- return NS_ERROR_NOT_IMPLEMENTED;
- }
- NS_IMETHODIMP nsHttpProtocolHandler::SetProductComment(const nsACString & aProductComment)
- {
- return NS_ERROR_NOT_IMPLEMENTED;
- }
-
- /* readonly attribute ACString platform; */
- NS_IMETHODIMP nsHttpProtocolHandler::GetPlatform(nsACString & aPlatform)
- {
- return NS_ERROR_NOT_IMPLEMENTED;
- }
-
- /* readonly attribute ACString oscpu; */
- NS_IMETHODIMP nsHttpProtocolHandler::GetOscpu(nsACString & aOscpu)
- {
- return NS_ERROR_NOT_IMPLEMENTED;
- }
-
- /* attribute ACString language; */
- NS_IMETHODIMP nsHttpProtocolHandler::GetLanguage(nsACString & aLanguage)
- {
- return NS_ERROR_NOT_IMPLEMENTED;
- }
- NS_IMETHODIMP nsHttpProtocolHandler::SetLanguage(const nsACString & aLanguage)
- {
- return NS_ERROR_NOT_IMPLEMENTED;
- }
-
- /* attribute ACString misc; */
- NS_IMETHODIMP nsHttpProtocolHandler::GetMisc(nsACString & aMisc)
- {
- return NS_ERROR_NOT_IMPLEMENTED;
- }
- NS_IMETHODIMP nsHttpProtocolHandler::SetMisc(const nsACString & aMisc)
- {
- return NS_ERROR_NOT_IMPLEMENTED;
- }
-
- /* End of implementation class template. */
- #endif
-
- /**
- * At initialization time, the HTTP handler will initialize each service
- * registered under this category:
- */
- #define NS_HTTP_STARTUP_CATEGORY "http-startup-category"
- /**
- * nsIObserver notification corresponding to startup category. Services
- * registered under the startup category will receive this observer topic at
- * startup if they implement nsIObserver. The "subject" of the notification
- * is the nsIHttpProtocolHandler instance.
- */
- #define NS_HTTP_STARTUP_TOPIC "http-startup"
- /**
- * Before an HTTP request is sent to the server, this observer topic is
- * notified. The observer of this topic can then choose to set any additional
- * headers for this request before the request is actually sent to the server.
- * The "subject" of the notification is the nsIHttpChannel instance.
- */
- #define NS_HTTP_ON_MODIFY_REQUEST_TOPIC "http-on-modify-request"
- /**
- * After an HTTP server response is received, this observer topic is notified.
- * The observer of this topic can interrogate the response. The "subject" of
- * the notification is the nsIHttpChannel instance.
- */
- #define NS_HTTP_ON_EXAMINE_RESPONSE_TOPIC "http-on-examine-response"
- /**
- * The observer of this topic is notified after the received HTTP response
- * is merged with data from the browser cache. This means that, among other
- * things, the Content-Type header will be set correctly.
- */
- #define NS_HTTP_ON_EXAMINE_MERGED_RESPONSE_TOPIC "http-on-examine-merged-response"
-
- #endif /* __gen_nsIHttpProtocolHandler_h__ */
-